home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 March / EnigmA AMIGA RUN 05 (1996)(G.R. Edizioni)(IT)[!][issue 1996-03][Skylink CD IV].iso / earcd / comm1 / exclutls.lha / Callers / Callers.doc < prev    next >
Text File  |  1996-01-28  |  10KB  |  276 lines
  1. ;Released as public domain 27-Jan-1996 by the author Renze de Ruiter
  2.  
  3.  
  4.  
  5.  
  6.                                  Callers v3.01
  7.                                 ~~~~~~~~~~~~~~~
  8.                     (c)1994 Renze de Ruiter & David Dustin
  9.                                Eclipse Software
  10.  
  11.  
  12.                                 10 August, 1994
  13.  
  14.  
  15.  
  16.  
  17. Preface
  18. ~~~~~~~
  19.   The  programs  and  files  in  this  distribution are ShareWare, but are also
  20. Copyright  (c)  Eclipse Software.  They may be freely distributed as long as no
  21. more than a minimum fee is charged to cover time and copying costs.  Permission
  22. is  given  for  this  distribution  archive  to  be  placed  into Public-Domain
  23. collections such as the Amiga Library run by Fred Fish or Aminet.
  24.  
  25.   They  may  also  be  made  freely available  to any REGISTERED Excelsior! BBS
  26. sysops, and may be placed on any Support BBS's for the Excelsior! BBS.
  27.  
  28.  
  29.   If  you  do  decide to make use of Callers, you are suggested to send a small
  30. donation,  or at  least word that you are using our software, as payment.  This
  31. will get you the latest version of Callers, and also any other programs we have
  32. released.
  33.  
  34.  
  35.   If  you do have any suggestions, bug notes or ideas about this program, or if
  36. you would like to donate something, please let us know.
  37.  
  38.  
  39.     Write to us at the following addresses:
  40.  
  41.                                 Renze de Ruiter
  42.                               31 Hillcrest Drive
  43.                                Palmerston North
  44.                                   NEW ZEALAND
  45.  
  46.                                  David Dustin
  47.                               30 Richmond Avenue
  48.                                Palmerston North
  49.                                   NEW ZEALAND
  50.  
  51.  
  52.     Or we can be contacted via:
  53.                           renze@trans.manawatu.gen.nz
  54.                          dave@eclipsnz.manawatu.gen.nz
  55.  
  56.  
  57.  
  58.  
  59. Contents
  60. ~~~~~~~~
  61.     1.     An introduction
  62.     2.     Requirments
  63.     3.     Usage
  64.     4.     History
  65.     5.     Future
  66.     6.     Credits / Copyrights
  67.  
  68.  
  69.  
  70. 1.  An Introduction
  71. ~~~~~~~~~~~~~~~~~~~
  72.   Callers  was  written  because  I  recently  decided  to  upgrade  my  BBS to
  73. Excelsior!  BBS.  I had originally written Callers for Falcon CBCS, and  when I
  74. upgraded,  I  needed  the  same  sort of program.  And seeing as the caller log
  75. files are totally different, I had to re-write Callers from the bottom up.
  76.  
  77.  
  78.  
  79. 2.  Requirments
  80. ~~~~~~~~~~~~~~~
  81.   Callers  can  be  used on any machine, and does not require Excelsior!  to be
  82. running  to  work.   It must be executed from Excelsior's root directory, as it
  83. tries  to  load  the  SystemData  file,  which contains the path of the Callers
  84. logfile.  You can also specify a logfile to view using the LOGFILE option.
  85.  
  86.   It  is  recommended  that you use a utility called TRIMLOG by David Dustin to
  87. trim  your  log to a number of entries, rather than deleting it outright.  This
  88. ensures there is always something for Callers to read.
  89.  
  90.   As  of  version  2.30,  Callers  will  only  display  the  POSTS column under
  91. Excelsior!   v0.979 and up, with the DETAILED POST LOG switch on.  Without this
  92. switch, or under older versions, the POSTS column will only display zeroes.
  93.  
  94.   As  of  version 2.40, Callers will display UL and DL columns under Excelsior!
  95. v0.979  and up, with the DETAILED TRANSFER LOG switch on.  Without this switch,
  96. or under older versions, the UL and DL columns will only display zeroes.
  97.  
  98.   Callers  is  now  ShareWare.  If you use the program and like it, or just get
  99. sick  of  the  5  second delay, either send us a small donation, or just a note
  100. saying  "Hello.  I use your program Callers!  It's neat!" and I will send you a
  101. key, as long as the postage is not too extravagant.  Via E-mail is preferrable.
  102.  
  103.  
  104.  
  105. 3.  Usage
  106. ~~~~~~~~~
  107.   Callers  can  only  be used from the CLI/SHELL, or via Excelsior.  It outputs
  108. four  columns  listing  the  date  and  time  of  the call, who called, at what
  109. baudrate,  and  how  long  they  spent online.  The users are listed in reverse
  110. order, with the last user first.
  111.  
  112.   When run from the shell, the arguments available are:
  113.   LF=LOGFILE/K,
  114.   H=HIDE/K,
  115.   HID=HIDEID/K/N,
  116.   HF=HIDEFILE/K,
  117.   M=MAX/K/N,
  118.   T=TIMEONLINE/K/N,
  119.   L=LOCALOFF/S,
  120.   N=NOANSI/S,
  121.   NT=NOTOTALS/S,
  122.   USER/M/A
  123.  
  124.  
  125. - LOGFILE is an optional name of the logfile to view.  Useful if you wish to
  126.   view a logfile other than the defualt one.
  127.  
  128. - HIDE will enable you to hide a specific alias in the list.  For example, if
  129.   you wished to hide your own logins on your BBS, you would use:
  130.  
  131.   555,     WC,         0,      "1-32",      "\#4Xcel:Callers HIDE=Renze %1\"
  132.  
  133.   Of course you would place your own alias in here instead.
  134.  
  135. - HIDEID is as above, but will allow you to hide a specific user's ID number.
  136.  
  137. - HIDEFILE allows you to have a list of aliases (one per line) which you do not
  138.   wish to have displayed in the list.
  139.  
  140. - MAX will let you specify the number of callers to display.  The display will
  141.   end when this number is reached.
  142.  
  143. - TIMEONLINE allows you to specify the minimum time a user has spent online to
  144.   have them displayed in the list. E.g. TIMEONLINE=10 will only list those
  145.   users who spent 10 minutes or more online.
  146.  
  147. - LOCALOFF tells Callers to ignore local and sysop logins.
  148.  
  149. - NOANSI will switch off the ANSI codes, making for a neater display in the
  150.   CLI/Shell.  Just place an N or the word NOANSI on the end of the command
  151.   line.
  152.  
  153. - NOTOTALS switches off the totals at the bottom of the columns.
  154.  
  155. - USER is the alias of the current user online.  If run from the shell, use
  156.   your alias as the argument.  When you place this command in your EX.BBSMenus
  157.   file, add a line similar to this:
  158.  
  159.   555,     WC,         0,      "1-32",      "\#4Xcel:Callers %1\"
  160.  
  161.   \#4 will run a shared access DOS door, and %1 will pass the current user's
  162.   alias as an argument.
  163.  
  164.  
  165.  
  166. 4.  History
  167. ~~~~~~~~~~~
  168. V1.00   Unknown 92
  169.     * First release.  Written in ARexx for Falcon CBCS
  170.  
  171. V1.10   28 January 93
  172.     * Rewrote in ARexx for use with Excelsior! BBS
  173.  
  174. V2.00   21 February 93
  175.     * Rewrote in E (my first E program) for Excelsior! BBS
  176.  
  177. V2.01   22 February 93
  178.     * Bug fix: Added '\b' to WriteF's to add carriage returns.
  179.       Would not work properly through Excelsior! without them.
  180.  
  181. V2.10   22 February 93 (later that day...)
  182.     * Added the HIDE option to hide specific aliases in the display.
  183.     * Added NOANSI switch for CLI use.
  184.  
  185. V2.11   23 February 93
  186.     * Noticed a bug if the user had spaces in his/her alias, it would
  187.       parse them as separate arguments, and as I couldn't use quotes
  188.       within the EX.BBSMenus file, I had to use underscores.
  189.  
  190. V2.12   23 February 93 (I really have to get a social life...)
  191.     * Excelsior has a bug with it's %19 DOS door argument.  It is
  192.       supposed to place underscores in the user's alias in place of
  193.       the spaces.  It instead tries to place underscores in ALL of
  194.       the spaces, even between the command and the argument.  This
  195.       version is a work-around of this problem until the boys at
  196.       Sycom fix the bug.
  197.  
  198. V2.13   2 March 93
  199.     * Rearranged the ReadArgs() template to allow the use of /M
  200.       multiple strings.  Now will not need quotes around the user's
  201.       alias to work.  I'd still like to see the %19 bug fixed though.
  202.  
  203. V2.20   2 March 93
  204.     * Added MAX option for setting maximum number of lines to be
  205.       displayed.
  206.  
  207. V2.21   14 March 93
  208.     * Changed to ShareWare and requires keyfile for full operation.
  209.  
  210. V2.30   26 March 93
  211.     * Reorganised the columns to allow room for an extra column.
  212.     * Added a POSTS column, displaying how many PUBLIC messages (not PRIVATE
  213.       MAILS) the user posted while online.
  214.  
  215. V2.40   30 March 93
  216.     * Reorganised the columns again to make room for two more columns.
  217.     * Added UL and DL columns to display how many uploads or downloads the
  218.       users made while online.
  219.  
  220. V2.41   1 April 93 (no, it's NOT an April fools joke!!)
  221.     * Minor change for the new version of Excelsior - v0.980.
  222.  
  223.                         ......zzzzzzZZZZZZzzzzzz......
  224.  
  225. V2.50   7 July 93 (gee, that was a long hiatus, wasn't it?)
  226.     * Minor change for bug fix in Excelsior v0.993. (about bloody time!!!)
  227.  
  228.                         ......zzzzzzZZZZZZzzzzzz......
  229.  
  230. V2.60   8 December 93 (ummm... yeah... so it's been a while!)
  231.     * Redo the scan for YET ANOTHER logfile format change... I know the change
  232.       happened quite some time ago, but I was lazy. :)
  233.  
  234.                         ......zzzzzzZZZZZZzzzzzz......
  235.  
  236. V3.00   13 July 94 (CRIKEY!  Call me Rip Van Winkle!)
  237.     * Complete rewrite in assembler (Ouch! Painful!)
  238.     * Added ANSI boxes to keep Dave happy.
  239.     * Dave decided to "help out".  :)
  240.     * Dave added TIMEONLINE function. (fair enough)
  241.     * Dave added CTRL-C checking. (that's useful)
  242.     * Dave added extended help on the command line. (that's helpful)
  243.     * Dave added totals at the bottom of the columns. (going overboard!)
  244.     * Dave added HIDEID function. (that's enough, Dave.)
  245.     * Dave added HIDEFILE function. (enough already!)
  246.     * Dave added NOTOTALS function. (<<SIGH>> I give up.)
  247.  
  248.  
  249. V3.01   10 August 94  <Dave did update>
  250.     * Changed method of finding default logfile from explicit path, to using
  251.       Excelsior's SystemData file.
  252.     * Added LOGFILE option
  253.  
  254.  
  255.  
  256. 5.  Future
  257. ~~~~~~~~~~
  258.     - Read lines to search for from the ENGLISH file, or possibly some form of
  259.       config file, depending on my mood and user feedback.
  260.  
  261. Any suggestions would be welcome.  See the beginning of this file for a contact
  262. address.
  263.  
  264.  
  265.  
  266. 6.  Credits / Copyrights
  267. ~~~~~~~~~~~~~~~~~~~~~~~~
  268.     Main code                   - Renze de Ruiter and David Dustin
  269.                                                     (psychotic coder)
  270.  
  271.     Callers                     - (c) 1994 Eclipse Software
  272.     Excelsior! BBS              - (c) 1992-94 Sycom
  273.     Falcon CBCS                 - (c) 1989-91 Brian Fedhrau
  274.     Amiga E                     - (c) 1993-94 Wouter van Oortmerssen
  275.     Kickstart/Workbench         - (c) 1985-94 Commodore-Amiga, Inc.
  276.